<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="TransCrossbound,com.flashsim.FStEng.Three.TransCrossbound,stPath,upLvls,hist,xfn" name="keywords">
<title>com.flashsim.FStEng.Three.TransCrossbound</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TransCrossbound - API Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">FlashSim State Engine, version 3.0</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/flashsim/FStEng/Three/TransCrossbound.html&amp;com/flashsim/FStEng/Three/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TransCrossbound</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TransCrossbound"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.flashsim.FStEng.Three</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TransCrossbound</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="IStateTransition.html">IStateTransition</a></td>
</tr>
</table>
<p></p>
    Transition linking two states that are not siblings.
    <p>The TransCrossbound is a transition that links two states (source and target) not in the same 
    layer of the network, i.e., not sibling states.  To traverse this transition requires
    knowing the least common ancestor (LCA) of the two states, and then the path from the LCA
    down to the target (or history).
    Note: we use composition instead of inheritance from Trans, since the constructor signature
    is different.</p>
    
    <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#hist">hist</a> : Boolean<div class="summaryTableDescription">
   Whether this transition goes to a history node.</div>
</td><td class="summaryTableOwnerCol">TransCrossbound</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#stPath">stPath</a> : Array<div class="summaryTableDescription">
   An array consisting of state identifiers from the LCA to the target state.</div>
</td><td class="summaryTableOwnerCol">TransCrossbound</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#upLvls">upLvls</a> : Number<div class="summaryTableDescription">
   How many state network levels upward (toward the topmost state) must be traversed to get to the LCA.</div>
</td><td class="summaryTableOwnerCol">TransCrossbound</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#xfn">xfn</a> : Function<div class="summaryTableDescription">
   A function one can associate with the transition to get invoked when the transition is triggered.</div>
</td><td class="summaryTableOwnerCol">TransCrossbound</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#TransCrossbound()">TransCrossbound</a>(transfn:Function, levels_up:int, state_path:Array, doHistory:Boolean = false)</div>
<div class="summaryTableDescription">
  A transition that jumps across more than one level of the state hierarchy (above or below).</div>
</td><td class="summaryTableOwnerCol">TransCrossbound</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="hist"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hist</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>hist:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Whether this transition goes to a history node.
   </p><p>The default value is <code>false</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get hist():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set hist(value:Boolean):void</code>
<br>
</div>
<a name="stPath"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">stPath</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var stPath:Array</code><p>
   An array consisting of state identifiers from the LCA to the target state.
   </p></div>
<a name="upLvls"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">upLvls</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var upLvls:Number</code><p>
   How many state network levels upward (toward the topmost state) must be traversed to get to the LCA.
   </p></div>
<a name="xfn"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">xfn</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>xfn:Function</code>&nbsp;&nbsp;[read-write]<p>
   A function one can associate with the transition to get invoked when the transition is triggered.
   </p><p>The default value is <code>&lt;code&gt;null&lt;/code&gt;</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get xfn():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set xfn(value:Function):void</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="TransCrossbound()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">TransCrossbound</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function TransCrossbound(transfn:Function, levels_up:int, state_path:Array, doHistory:Boolean = false)</code><p>
  A transition that jumps across more than one level of the state hierarchy (above or below).
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">transfn</span>:Function</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">levels_up</span>:int</code> &mdash; Number of levels to ascend to reach parent of this state and target state.  Can also be -1 to indicate target state is within (at any sub-level) the current hierarchical state. 
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">state_path</span>:Array</code> &mdash; array of values either down to the destination state (in order of traversal, top to bottom), or from the common parent state (common to current and destination) down to the destination state (in order of traversal, top to bottom)
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">doHistory</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Boolean value set to true if the history value should be used to find the ultimate state after traversing the state path
  </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
